Skip to content

feat: implement dynamic versioning with setuptools_scm #671

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat: implement dynamic versioning with setuptools_scm #671

wants to merge 3 commits into from

Conversation

nicogodet
Copy link
Contributor

  • Replace hardcoded version with setuptools_scm integration
  • Configure setuptools_scm to write version to _version.py
  • Add fallback mechanisms for development environments
  • Update .gitignore to exclude generated _version.py

This change enables automatic version management from git tags,
eliminating the need to manually update version strings.

@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request dependencies Project dependencies. packaging Making the toolbelt usable on different ways and platforms. tooling Development tooling quality Tests, project resiliency, etc. labels May 24, 2025
@codecov Codecov
Copy link

codecov bot commented May 24, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 45.45455% with 6 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
qgis_deployment_toolbelt/__about__.py 25.00% 6 Missing ⚠️

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #671      +/-   ##
==========================================
- Coverage   71.90%   71.88%   -0.03%     
==========================================
  Files          48       48              
  Lines        3271     3279       +8     
  Branches      576      577       +1     
==========================================
+ Hits         2352     2357       +5     
- Misses        704      705       +1     
- Partials      215      217       +2
Flag Coverage Δ
unittests 71.24% <36.36%> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
qgis_deployment_toolbelt/commands/upgrade.py 68.81% <100.00%> (+3.98%) ⬆️
qgis_deployment_toolbelt/__about__.py 75.00% <25.00%> (-25.00%) ⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions github-actions bot added the ci-cd Continuous integration and deployment. label May 24, 2025
@nicogodet nicogodet force-pushed the feature/dynamic-version-setuptools-scm branch from f1e5468 to e621211 Compare May 24, 2025 17:05
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@Guts
Copy link
Collaborator

Guts commented May 24, 2025

AI generated?

@nicogodet
Copy link
Contributor Author

for version_info_templater part, yes

@Guts
Copy link
Collaborator

Guts commented Jun 16, 2025

@nicogodet I think we should first switch to pyproject in a dedicated PR. Check everything works as previously in packaging and then change the way of versioning.

Still I've already made those moves on other projects and it's the good things to do.

@nicogodet
Copy link
Contributor Author

You already convert this project to pyproject.toml 🧐

#556

@Guts
Copy link
Collaborator

Guts commented Jun 16, 2025

You already convert this project to pyproject.toml 🧐

#556

😂 I sincerely and completely forgot about this one

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
ci-cd Continuous integration and deployment. dependencies Project dependencies. documentation Improvements or additions to documentation enhancement New feature or request packaging Making the toolbelt usable on different ways and platforms. quality Tests, project resiliency, etc. tooling Development tooling
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nicogodet @Guts